home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat1 / grelnotes.z / grelnotes
Text File  |  1998-10-20  |  21KB  |  397 lines
  1.  
  2.  
  3.  
  4. GGGGRRRREEEELLLLNNNNOOOOTTTTEEEESSSS((((1111))))                                                      GGGGRRRREEEELLLLNNNNOOOOTTTTEEEESSSS((((1111))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      grelnotes - graphical on-line release notes viewer
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ggggrrrreeeellllnnnnooootttteeeessss [ X toolkitoption... ] [----rrrrppppaaaatttthhhh path]
  13.                [product] [chapter]
  14.  
  15. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.      _g_r_e_l_n_o_t_e_s provides a graphical interface for viewing the on-line release
  17.      notes.
  18.  
  19.      For each software product installed on the workstation there is a set of
  20.      on-line release notes. Each set of release notes contains a number of
  21.      chapters providing important information about the product. _g_r_e_l_n_o_t_e_s
  22.      makes it possible to quickly locate and browse these release notes.
  23.  
  24.      If _g_r_e_l_n_o_t_e_s is executed with no arguments, it will come up displaying
  25.      the release notes for the "IRIX" software product. The "IRIX" product is
  26.      the basic software included on the workstation (eg. unix and utilities).
  27.      If these release notes are not installed, the release notes for the
  28.      product "eoe" will be displayed and if these are not present, the first
  29.      set of release notes found will be displayed.
  30.  
  31.      If _p_r_o_d_u_c_t is specified, the program will come up displaying the first
  32.      chapter of the release notes for that product. If _c_h_a_p_t_e_r is specified in
  33.      addition to _p_r_o_d_u_c_t the program will come up displaying this chapter of
  34.      the product's release notes.
  35.  
  36. VVVVIIIIEEEEWWWWIIIINNNNGGGG RRRREEEELLLLEEEEAAAASSSSEEEE NNNNOOOOTTTTEEEESSSS
  37.      The _g_r_e_l_n_o_t_e_s program window consists of a menu bar at the top, a product
  38.      and chapter title display below that, the document text viewer and a set
  39.      of chapter movement buttons at the bottom.
  40.  
  41.      When _g_r_e_l_n_o_t_e_s comes up it will be displaying a chapter of a product's
  42.      release notes. The product and chapter currently displayed is indicated
  43.      just below the program menu bar.
  44.  
  45.      If you wish to read this chapter you may use the scrollbar and arrow
  46.      buttons to the right of the text viewer to scroll through the document.
  47.      The following keyboard keys may also be used for document browsing:
  48.  
  49.      UUUUpppp////DDDDoooowwwwnnnn aaaarrrrrrrroooowwwwssss      Move up/down one line of text
  50.  
  51.      PPPPaaaaggggeeee UUUUpppp////DDDDoooowwwwnnnn        Move up/down one page of text
  52.  
  53.      HHHHoooommmmeeee////EEEEnnnndddd            Move to top of first/last page
  54.  
  55.      SSSSppppaaaacccceeeebbbbaaaarrrr            Move down one page of text
  56.  
  57.      A new product may be selected from the PPPPrrrroooodddduuuuccccttttssss item on the program menu
  58.      bar.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. GGGGRRRREEEELLLLNNNNOOOOTTTTEEEESSSS((((1111))))                                                      GGGGRRRREEEELLLLNNNNOOOOTTTTEEEESSSS((((1111))))
  71.  
  72.  
  73.  
  74.      A new chapter may be selected from the CCCChhhhaaaapppptttteeeerrrrssss item on the program menu
  75.      bar. A new chapter may also be selected using the PPPPrrrreeeevvvv CCCChhhhaaaapppptttteeeerrrr or NNNNeeeexxxxtttt
  76.      CCCChhhhaaaapppptttteeeerrrr buttons at the bottom of the program window. These buttons move
  77.      sequentially through the list of chapters.
  78.  
  79.      Text in the text viewer may be selected for pasting into other documents
  80.      or applications. Selection of text is performed using the left mouse
  81.      button. Note that the document or application into which text is to be
  82.      pasted must obey the ICCCM conventions for cut and paste operations.
  83.  
  84. PPPPRRRRIIIINNNNTTTTIIIINNNNGGGG RRRREEEELLLLEEEEAAAASSSSEEEE NNNNOOOOTTTTEEEESSSS
  85.      _g_r_e_l_n_o_t_e_s provides printing of release notes by selecting the PPPPrrrriiiinnnntttt............
  86.      item from the FFFFiiiilllleeee menu. Either the current chapter or all chapters of
  87.      the current product may be printed. All printing is done on the default
  88.      system printer. Use the _S_y_s_t_e_m _M_a_n_a_g_e_r program to establish a default
  89.      printer on your system if one has not already been selected.
  90.  
  91. UUUUPPPPDDDDAAAATTTTIIIINNNNGGGG TTTTHHHHEEEE PPPPRRRROOOODDDDUUUUCCCCTTTT AAAANNNNDDDD CCCCHHHHAAAAPPPPTTTTEEEERRRR LLLLIIIISSSSTTTTSSSS
  92.      If products have been added or removed from the system while _g_r_e_l_n_o_t_e_s is
  93.      running, the list of products and chapters that _g_r_e_l_n_o_t_e_s knows about can
  94.      be updated by selecting UUUUppppddddaaaatttteeee LLLLiiiisssstttt from the FFFFiiiilllleeee menu.
  95.  
  96. RRRREEEELLLLEEEEAAAASSSSEEEE NNNNOOOOTTTTEEEESSSS DDDDIIIIRRRREEEECCCCTTTTOOOORRRRYYYY
  97.      Typically the release notes for all products installed on the workstation
  98.      are located in subdirectories of /_u_s_r/_r_e_l_n_o_t_e_s. By default, _g_r_e_l_n_o_t_e_s
  99.      looks in this directory for release notes. A different release notes
  100.      directory path may be specified in a number of ways. If the program
  101.      resource rrrreeeellllnnnnooootttteeeessssPPPPaaaatttthhhh is set to a directory path, _g_r_e_l_n_o_t_e_s will look in
  102.      this directory for release notes. If the environment variable
  103.      RRRREEEELLLLNNNNOOOOTTTTEEEESSSSPPPPAAAATTTTHHHH is set to a path, the program will look there for release
  104.      notes. Finally, if the command-line option ----rrrrppppaaaatttthhhh is specified, the path
  105.      argument to this option will be used as the release notes directory.  The
  106.      environment variable takes precedence over the program resource and the
  107.      command-line option takes precedence over the environment variable.
  108.  
  109. WWWWIIIIDDDDGGGGEEEETTTT HHHHIIIIEEEERRRRAAAARRRRCCCCHHHHYYYY
  110.      The following is an abbreviated widget hierarchy for _g_r_e_l_n_o_t_e_s.
  111.  
  112.      grelnotes (Grelnotes)
  113.                topForm (Form)
  114.                menuBar (RowColumn)
  115.                placeFrame (Frame)
  116.                placeForm (Form)
  117.                productLabel (Label)
  118.                product (Label)
  119.                chapterLabel (Label)
  120.                chapter (Label)
  121.                textViewSW (ScrolledWindow)
  122.                textViewSB (ScrollBar)
  123.                textViewFM (Frame)
  124.                textView (TextView)
  125.                buttonRC (RowColumn)
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. GGGGRRRREEEELLLLNNNNOOOOTTTTEEEESSSS((((1111))))                                                      GGGGRRRREEEELLLLNNNNOOOOTTTTEEEESSSS((((1111))))
  137.  
  138.  
  139.  
  140.                prevChapter (PushButton)
  141.                nextChapter (PushButton)
  142.  
  143. PPPPRRRROOOOGGGGRRRRAAAAMMMM RRRREEEESSSSOOOOUUUURRRRCCCCEEEESSSS
  144.      _g_r_e_l_n_o_t_e_s is written using the standard X toolkit and the Motif widget
  145.      set. The program accepts all standard Xt/Motif resources and command line
  146.      options. In addition to these resources the following resources are
  147.      specific to the _g_r_e_l_n_o_t_e_s program and may be specified by the user.
  148.  
  149.      rrrreeeellllnnnnooootttteeeessssPPPPaaaatttthhhh (class RRRReeeellllnnnnooootttteeeessssPPPPaaaatttthhhh)
  150.                               Specifies the root release notes directory. Each
  151.                               product's release notes are a subdirectory of
  152.                               this root pathname. See above discussion.
  153.  
  154.      tttteeeemmmmppppPPPPaaaatttthhhh (class TTTTeeeemmmmppppPPPPaaaatttthhhh)
  155.                               Specifies the directory into which temporary
  156.                               files created by the program should be placed.
  157.                               The path should not end with '/'.  Note that the
  158.                               environment variable TTTTMMMMPPPPDDDDIIIIRRRR, if set, overrides
  159.                               any setting of this resource.
  160.  
  161.      TTTTeeeexxxxttttVVVViiiieeeewwww....nnnnoooorrrrmmmmaaaallllFFFFoooonnnntttt (class FFFFoooonnnntttt)
  162.                               Specifies the font to be used for regular text.
  163.                               See note below.
  164.  
  165.      TTTTeeeexxxxttttVVVViiiieeeewwww....uuuunnnnddddeeeerrrrlllliiiinnnneeeeFFFFoooonnnntttt (class FFFFoooonnnntttt)
  166.                               Specifies the font to be used for italicized or
  167.                               underlined text. See note below.
  168.  
  169.      TTTTeeeexxxxttttVVVViiiieeeewwww....bbbboooollllddddFFFFoooonnnntttt (class FFFFoooonnnntttt)
  170.                               Specifies the font to be used for bolded text.
  171.                               See note below.
  172.  
  173.      TTTTeeeexxxxttttVVVViiiieeeewwww....bbbboooollllddddUUUUnnnnddddeeeerrrrFFFFoooonnnntttt (class FFFFoooonnnntttt)
  174.                               Specifies the font to be used for text that is
  175.                               both bold and italicized or underlined. See note
  176.                               below.
  177.  
  178.      TTTTeeeexxxxttttVVVViiiieeeewwww....nnnnoooorrrrmmmmaaaallllFFFFoooorrrreeeeggggrrrroooouuuunnnndddd (class FFFFoooorrrreeeeggggrrrroooouuuunnnndddd)
  179.                               Specifies the foreground color for regular text.
  180.  
  181.      TTTTeeeexxxxttttVVVViiiieeeewwww....uuuunnnnddddeeeerrrrlllliiiinnnneeeeFFFFoooorrrreeeeggggrrrroooouuuunnnndddd (class FFFFoooorrrreeeeggggrrrroooouuuunnnndddd)
  182.                               Specifies the foreground color for italicized or
  183.                               underlined text.
  184.  
  185.      TTTTeeeexxxxttttVVVViiiieeeewwww....bbbboooollllddddFFFFoooorrrreeeeggggrrrroooouuuunnnndddd (class FFFFoooorrrreeeeggggrrrroooouuuunnnndddd)
  186.                               Specifies the foreground color for bolded text.
  187.  
  188.      TTTTeeeexxxxttttVVVViiiieeeewwww....bbbboooollllddddUUUUnnnnddddeeeerrrrFFFFoooorrrreeeeggggrrrroooouuuunnnndddd (class FFFFoooorrrreeeeggggrrrroooouuuunnnndddd)
  189.                               Specifies the foreground color for bolded and
  190.                               underlined text.
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. GGGGRRRREEEELLLLNNNNOOOOTTTTEEEESSSS((((1111))))                                                      GGGGRRRREEEELLLLNNNNOOOOTTTTEEEESSSS((((1111))))
  203.  
  204.  
  205.  
  206.      TTTTeeeexxxxttttVVVViiiieeeewwww....sssseeeelllleeeeccccttttiiiioooonnnnFFFFoooorrrreeeeggggrrrroooouuuunnnndddd (class BBBBaaaacccckkkkggggrrrroooouuuunnnndddd)
  207.                               Specifies the foreground (text) color for
  208.                               selected text.
  209.  
  210.      TTTTeeeexxxxttttVVVViiiieeeewwww....sssseeeelllleeeeccccttttiiiioooonnnnBBBBaaaacccckkkkggggrrrroooouuuunnnndddd (class FFFFoooorrrreeeeggggrrrroooouuuunnnndddd)
  211.                               Specifies the background color for selected
  212.                               text.
  213.  
  214.      TTTTeeeexxxxttttVVVViiiieeeewwww....tttteeeexxxxttttCCCCoooolllluuuummmmnnnnssss (class TTTTeeeexxxxttttCCCCoooolllluuuummmmnnnnssss)
  215.                               Specifies the number of columns to be displayed
  216.                               by the text viewer when _g_r_e_l_n_o_t_e_s comes up.
  217.  
  218.      TTTTeeeexxxxttttVVVViiiieeeewwww....tttteeeexxxxttttRRRRoooowwwwssss (class TTTTeeeexxxxttttRRRRoooowwwwssss)
  219.                               Specifies the number of rows to be displayed by
  220.                               the text viewer when _g_r_e_l_n_o_t_e_s comes up.
  221.  
  222.      TTTTeeeexxxxttttVVVViiiieeeewwww....bbbbllllaaaannnnkkkkCCCCoooommmmpppprrrreeeessssssss (class BBBBllllaaaannnnkkkkCCCCoooommmmpppprrrreeeessssssss)
  223.                               The on-line release notes have been formatted
  224.                               for printing with a standard page length.
  225.                               Therefore, pages have been padded with trailing
  226.                               blank lines where necessary. This resource is
  227.                               used to minimize the number of blank lines
  228.                               displayed.  This resource specifies a blank line
  229.                               threshold. Consecutive blank lines up to this
  230.                               threshold will be displayed. Any remaining
  231.                               consecutive blank lines will be ignored. Set
  232.                               this resource to zero (0) to disable blank line
  233.                               compression.
  234.  
  235. TTTTRRRRAAAANNNNSSSSLLLLAAAATTTTIIIIOOOONNNNSSSS
  236.      The _g_r_e_l_n_o_t_e_s program uses the following defaults for keyboard navigation
  237.      and text selection. The translations may be changed using the
  238.      TTTTeeeexxxxttttVVVViiiieeeewwww....ttttrrrraaaannnnssssllllaaaattttiiiioooonnnnssss resource.
  239.  
  240.                       KKKKeeeeyyyy////BBBBuuuuttttttttoooonnnn            AAAAccccttttiiiioooonnnn RRRRoooouuuuttttiiiinnnneeee
  241.                       ______________________________________
  242.                       <Btn1Down>:           StartSelect()
  243.                       <Btn1Motion>:         DragSelect()
  244.                       <Btn1Up>:             CompleteSelect()
  245.                       <Key>Tab:             NextTabGroup()
  246.                       Ctrl<Key>Tab:         NextTabGroup()
  247.                       Shift<Key>Tab:        PrevTabGroup()
  248.                       Ctrl Shift<Key>Tab:   PrevTabGroup()
  249.                       <Key>osf3eginLine:    FirstPage()
  250.                       <Key>KP_Home:         FirstPage()
  251.                       <Key>KP_7:            FirstPage()
  252.                       <Key>osfEndLine:      LastPage()
  253.                       <Key>KP_End:          LastPage()
  254.                       <Key>KP_1:            LastPage()
  255.                       <Key>osfUp:           LineUp()
  256.                       <Key>KP_Up:           LineUp()
  257.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. GGGGRRRREEEELLLLNNNNOOOOTTTTEEEESSSS((((1111))))                                                      GGGGRRRREEEELLLLNNNNOOOOTTTTEEEESSSS((((1111))))
  269.  
  270.  
  271.  
  272.                       <Key>KP_8:            LineUp()
  273.                       <Key>osfDown:         LineDown()
  274.                       <Key>KP_Down:         LineDown()
  275.                       <Key>KP_2:            LineDown()
  276.                       <Key>osfPageUp:       PageUp()
  277.                       <Key>KP_Prior:        PageUp()
  278.                       <Key>KP_9:            PageUp()
  279.                       <Key>osfPageDown:     PageDown()
  280.                       <Key>KP_Next:         PageDown()
  281.                       <Key>KP_3:            PageDown()
  282.                       <Key>space:           PageDown()
  283.  
  284. AAAACCCCTTTTIIIIOOOONNNN RRRROOOOUUUUTTTTIIIINNNNEEEESSSS
  285.      The _g_r_e_l_n_o_t_e_s program contains the following action routines.
  286.  
  287.      SSSSttttaaaarrrrttttSSSSeeeelllleeeecccctttt(((())))       Begin a text selection.
  288.  
  289.      DDDDrrrraaaaggggSSSSeeeelllleeeecccctttt(((())))        Drag the text selection.
  290.  
  291.      CCCCoooommmmpppplllleeeetttteeeeSSSSeeeelllleeeecccctttt(((())))    Complete a text selection.
  292.  
  293.      NNNNeeeexxxxttttTTTTaaaabbbbGGGGrrrroooouuuupppp(((())))      Move to next tab group.
  294.  
  295.      PPPPrrrreeeevvvvTTTTaaaabbbbGGGGrrrroooouuuupppp(((())))      Move to previous tab group.
  296.  
  297.      FFFFiiiirrrrssssttttPPPPaaaaggggeeee(((())))         Scroll text to first page.
  298.  
  299.      LLLLaaaassssttttPPPPaaaaggggeeee(((())))          Scroll text to last page.
  300.  
  301.      LLLLiiiinnnneeeeUUUUpppp(((())))            Scroll text one line down so that the next line up is
  302.                          visible.
  303.  
  304.      LLLLiiiinnnneeeeDDDDoooowwwwnnnn(((())))          Scroll text one line up so that the next line down is
  305.                          visible.
  306.  
  307.      PPPPaaaaggggeeeeUUUUpppp(((())))            Scroll text one page down so that the next page up is
  308.                          visible.
  309.  
  310.      PPPPaaaaggggeeeeDDDDoooowwwwnnnn(((())))          Scroll text one page up so that the next page down is
  311.                          visible.
  312.  
  313. NNNNOOOOTTTTEEEE
  314.      The _g_r_e_l_n_o_t_e_s program displays pre-formatted release notes. The format
  315.      assumes the use of a fixed-width font for all text styles. In addition,
  316.      the format assumes that normal, underline, bold and bold-underline fonts
  317.      all have the same character width. The default fonts for the nnnnoooorrrrmmmmaaaallllFFFFoooonnnntttt,
  318.      uuuunnnnddddeeeerrrrlllliiiinnnneeeeFFFFoooonnnntttt, bbbboooollllddddFFFFoooonnnntttt and bbbboooollllddddUUUUnnnnddddeeeerrrrFFFFoooonnnntttt resources have been chosen to
  319.      adhere to these assumptions. If new fonts are to be specified for any of
  320.      these resources, the above assumptions should be observed or columnar
  321.      output may not be properly aligned.
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. GGGGRRRREEEELLLLNNNNOOOOTTTTEEEESSSS((((1111))))                                                      GGGGRRRREEEELLLLNNNNOOOOTTTTEEEESSSS((((1111))))
  335.  
  336.  
  337.  
  338. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  339.      man(1), relnotes(1)
  340.  
  341. FFFFIIIILLLLEEEESSSS
  342.      /usr/lib/X11/app-defaults/Grelnotes    Program resource file
  343.      /usr/relnotes/<product>/TC             Table of contents file for
  344.                                             <product>
  345.      /usr/relnotes/<product>/ch*.z          Release notes for <product>
  346.      /usr/tmp/grel<id>                      Temporary file
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.                                                                         PPPPaaaaggggeeee 6666
  394.  
  395.  
  396.  
  397.